feat: Add autodoc for event annotations #318
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Coverage issue is just because there is more code (comments), there is nothing to test in any of this. |
There was a problem hiding this comment.
This has my soft-approval. Thanks for doing this! We'll merge this once openedx/code-annotations#98 is merged so we can the code-annotations release instead. Is that okay?
timmc-edx
reviewed
Feb 20, 2024
timmc-edx
reviewed
Feb 20, 2024
bmtcril
force-pushed
the
bmtcril/autodoc-event-annotations
branch
from
e85be8b to
4086c95
Compare
Not all events are compatible with the bus, and some that are have never been configured for it that I could find. This is everything I could locate in the org.
It looks like the pii check config was removed at some point, but checks that pointed to it were left in place. This just finishes the removal.
bmtcril
force-pushed
the
bmtcril/autodoc-event-annotations
branch
from
4086c95 to
8ff3541
Compare
|
@timmc-edx @mariajgrimaldi this is ready for re-review. Changes since the last push:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description: Adds automatic documentation of annotated events for discoverability and ease of configuration. This is in draft until dependencies merge and release, so I can update requirements to the official version, I'll be adding event_key_fields for the rest of the events while that is in review. Generated docs look like this:
Dependencies: openedx/code-annotations#98
Installation instructions: List any non-trivial installation
instructions.
Testing instructions:
make requirementsshould sufficemake docsReviewers:
Merge checklist:
Post merge:
finished.